[DOCS] Reformat split index API docs #46713
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrodewig
added
>docs
|
Pinging @elastic/es-core-features |
|
Pinging @elastic/es-docs |
35 tasks
jrodewig
requested review from
debadair and
szabosteve
and removed request for
debadair
debadair
approved these changes
Oct 4, 2019
Comment on lines
32
to
34
| To split an index, | ||
| the index must be marked as read-only | ||
| and have a <<cluster-health,cluster health>> status of `green`. |
There was a problem hiding this comment.
This reads as if it's the index that needs to be green, rather than the cluster. If you change the shrink prereqs, I'd make a similar change here:
Before you can split an index:
- The index must be read-only.
- The <<cluster-health, cluster health>> status must be green.
| @@ -52,9 +103,9 @@ Splitting works as follows: | |||
| * Finally, it recovers the target index as though it were a closed index which | |||
| had just been re-opened. | |||
|
|
|||
There was a problem hiding this comment.
Like with shrinking, referring to splitting as "it" is a bit odd. If you make changes there, I'd make parallel changes here.
There was a problem hiding this comment.
Fixed with 6f981b9.
| ==== Wait For Active Shards | ||
|
|
||
| [[split-wait-active-shards]] | ||
| ==== Wait For active shards |
There was a problem hiding this comment.
Good catch. Fixed with 6f981b9.
This was referenced Oct 4, 2019
jrodewig
added a commit
that referenced
this pull request
Oct 4, 2019
jrodewig
added a commit
that referenced
this pull request
Oct 4, 2019
jrodewig
added a commit
that referenced
this pull request
Oct 4, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reformats the split API docs to align with the new API reference template.
Relates to #43765.